package edu.del.teamknowledgebase.common.result;

import lombok.Getter;

/**
 * 封装统一的接口响应结果，便于标准化输出给前端
 * @param <T> 响应数据类型
 */
@Getter
public class Result<T> {

    /**
     * 表示操作是否成功的标志
     * 成功时为 true，失败时为 false
     */
    private Boolean success;

    /**
     * 表示操作结果的错误码
     * 成功时为 0，失败时为具体的错误码
     */
    private Integer code;

    /**
     * 表示操作结果的错误信息
     * 成功时为空字符串，失败时为具体的错误信息
     */
    private String message;

    /**
     * 表示操作结果的数据
     * 成功时为具体的数据，失败时为 null
     */
    private T data;

    /**
     * 私有构造方法
     * 该构造方法被私有化，目的是防止外部直接创建 Result 类的实例
     * 这种设计通常用于实现工具类或单例模式，确保类的实例只能通过特定方法获取
     */
    private Result() {}

    /**
     * 创建一个新的 Result 对象。
     *
     * <p>示例用法：</p>
     * <pre>{@code
     * Result.<User>build()
     *     .success(true)
     *     .code(200)
     *     .message("操作成功")
     *     .data(user);
     * }</pre>
     *
     * @param <T> 数据类型
     * @return 新的Result对象，用于进一步配置
     */
    public static <T> Result<T> build() {
        return new Result<>();
    }

    /**
     * 创建一个表示成功操作的 Result 对象。
     *
     * @param <T> 数据类型
     * @param data 成功操作返回的数据
     * @return 一个包含成功状态、状态码、消息和数据的 Result 对象
     */
    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.success = true;
        result.code = ApiCode.SUCCESS.getCode();
        result.message = "success";
        result.data = data;
        return result;
    }

    /**
     * 创建一个表示失败操作的 Result 对象。
     *
     * @param <T> 数据类型
     * @param code 失败操作的状态码
     * @param message 失败操作的错误信息
     * @return 一个包含失败状态、状态码、消息和 null 数据的 Result 对象
     */
    public static <T> Result<T> fail(int code, String message) {
        Result<T> result = new Result<>();
        result.success = false;
        result.code = code;
        result.message = message;
        result.data = null;
        return result;
    }

    /**
     * 创建一个表示失败操作的 Result 对象，使用默认的错误信息
     *
     * @param message 失败操作的错误信息
     * @return 一个包含失败状态、状态码、错误信息和null数据的 Result 对象
     * @param <T> 数据类型
     */
    public static <T> Result<T> error(String message) {
        return fail(ApiCode.INTERNAL_ERROR.getCode(), message);
    }

    /**
     * 设置操作是否成功的标志
     *
     * @param success true 表示成功，false 表示失败
     * @return 当前 Result 对象，用于链式调用
     */
    public Result<T> success(boolean success) {
        this.success = success;
        return this;
    }

    /**
     * 设置操作结果的状态码
     *
     * @param code 状态码
     * @return 当前 Result 对象，用于链式调用
     */
    public Result<T> code(int code) {
            this.code = code;
            return this;
    }

    /**
     * 设置操作结果错误信息
     *
     * @param message 错误信息
     * @return 当前 Result 对象，用于链式调用
     */
    public Result<T> message(String message) {
        this.message = message;
        return this;
    }

    /**
     * 设置操作结果的数据
     * @param data 操作结果的数据
     * @return 当前 Result 对象，用于链式调用
     */
    public Result<T> data(T data) {
        this.data = data;
        return this;
    }

    /**
     * 创建一个表示成功操作的 Result 对象，使用默认的成功状态码和信息
     * @return 一个包含成功状态、默认状态码、默认消息和 null 数据的 Result 对象
     * @param <T> 数据类型
     */
    public static <T> Result<T> success() {
        return success(null);
    }

    /**
     * 创建一个表示失败操作的 Result 对象，使用指定的错误码和错误信息
     * @param apiCode 错误码
     * @return 一个包含失败状态、指定错误码和错误信息的 Result 对象
     * @param <T> 数据类型
     */
    public static <T> Result<T> fail(ApiCode apiCode) {
        return fail(apiCode.getCode(), apiCode.getMessage());
    }

    /**
     * 创建一个表示失败操作的 Result 对象，使用指定的错误码和错误信息
     * @param apiCode 错误码
     * @param message 错误信息
     * @return 一个包含失败状态、指定错误码和错误信息的 Result 对象
     * @param <T> 数据类型
     */
    public static <T> Result<T> fail(ApiCode apiCode, String message) {
        return fail(apiCode.getCode(), message);
    }
}


